Skip to main content

Session Recording

Objective

The Session Recording module records a video of a user based on their consent during their verification process.

Benefits

This module enhances the security and compliance by capturing an indisputable video consent during the verification process, providing a robust and legally sound solution.

InputOutput
The user's consent for the video recordingThe URL for the recorded video of the user's verification process

Configuration Options

You can configure to start and end the video recording module at any point of the user verification process based on your preference.

For most cases, we configure the video recording module to terminate when the user either:

  • Successfully completes the verification process, or
  • Exhausts the allowed re-attempts for the verification process.

The following image shows a sample step in the self video verification process where a user is required to provide their consent for the recording.

Recording Consent

Success Response

caution

Kindly verify the name of the module configured for you by the HyperVerge team. The response from the results API will reflect the same moduleId.
The following code snippet is a part of the response from the results API where the session recording module's moduleId is set as "session_module".

{
"moduleId": "session_module",
"videoImageUrl": "https://prod-audit-portal-ind.s3.ap-south-1.amazonaws.com/gkyc-ap-south-1/convert/2023-09-12/a46b10/1694491021610-1a4b2abf-7076-42f8-9b36-b66d73a97a1f/video.webm%3Bcodecs%3Dvp9%2Copus?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZRKK5ZMR47AB2L4C%2F20230914%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20230914T111224Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEFcaCmFwLXNvdXRoLTEiSDBGAiEAvXqyO5wlV7MjN18GErBf7ahX2OSIH%2FdaDhGK2GDBzf0CIQDtuU%2B8wuxD7z98Xm7%2BAc%2FO30zURPN74CJTacPK6pzCqyq%2BBQhAEAEaDDY1NTY3NjUyNTM0NyIMyj3x499xN04dyVwdKpsFP3sGgoJ4rig9qLmYZEJHqr9reGV3FcX66bRTMFM7PicLGf%2FLHunBoiu1%2Bcu2Pp%2Fb8dxjkLtdgA%2B1qKbfYVAmr1FPIkcTHbYIKYfnYDfqXDQXG7e%2BB4XI72krzfEgiHTYKqvQsH24laseuHtvXC0PVI3eax7Qqju7EmKXjgt6LLuqHiZKRlvyIeUubjiGRrT9%2Bl5iXuCh9b1ZW3nPIdAGaYLM88QApBYkI9gjuAkPz0UTZm%2BDfQgfdLeD1IyXQ%2FwfhBZS9sauiuo1FKMevbXZwCRPCpRhzal7nEPl0mzAgezz%2FjecQNj67NtAuzoJt3zOYBi4S5UFPhXfm9HJYKT2tuhdyrTFHaenmU0WI4RjcOCtinO5sLBe7%2BUags%2B%2F7ZeLBszJOtnUInqXPuBPCmVTayOg9mzSbOw9KWdejqqOs5gULjNlkTwdql1BDw14ugkbVjlEgf9hnWgxHNec%2FPs3ihzSycfcXF8MDj4TRsniFjshPxu6vbe5fs%2Fnk9cMQCN2vHkVFkV1PQuFACRzp5bAj%2Bvm%2BJBXOcshXC2YlFIJ1WPXL1ZyqnzOSwhe4BUFffH6I3GcgGAqxf1UFSZvH1vDSAGu%2FKB6njFtMoDjiM%2F0OCqUBzLNTXblzzgDlxUimMP32eFvqARDnSfzlWq9bWuGAMIjA1PhSfOsGR46tznzEN4XAJO4lKqpJonlX4HDDb7wmRgccxXCy0bbYGoyW5CyPEKhofWUFfp6gjVJeIWr81OnibOPYOhHCBLMQNmr1L1yWO%2BJ4OZLH2ICaWZrsoDaeQia8XPsKQELquOaFnz4MLP1QfV6bNPVMI4XRf4ClnKmqYFZN%2B8Qj5iN%2FZ49HKMQU6DsI7yzWw33SLXQvvHruXCvAopKDQw%2FaGGRvzD314qoBjqwAbPHwiVb1UbbzN3KF20Wav6P1HSA%2FYGFpMj2L27jmQQkfwSiP5Xxf6akxjuxaEsuXKO7WJR8InUL3S1xLfewqPokNia3Ic57BgjfwmfddVIT3T%2Bae2nE0WpY3Gehg%2FLfGq2ENCuv4D42ZBhSdYjCJbMpnmSAf3p7QUQYJrmSxIei0eOj3HOY9UgVXY8BQjsCJ0fNtvQLV8mCADO%2FQD2XWL%2Bjsl8K7li9hQo6hTktfGiO&X-Amz-Signature=21f2346cd31e3f0ea9698bcee1ac9eba90df42bdad96edc2714c70e91e965247&X-Amz-SignedHeaders=host",
"apiResponse": {
"status": "success",
"statusCode": 200,
"metadata": {
"requestId": "1694491021610-1a4b2abf-7076-42f8-9b36-b66d73a97a1f",
"transactionId": "sample-txn-id-11"
},
"result": {
"details": {
"uploadUrls": [
"https://prod-audit-portal-ind.s3.ap-south-1.amazonaws.com/gkyc-ap-south-1/convert/2023-09-12/a46b10/1694491021610-1a4b2abf-7076-42f8-9b36-b66d73a97a1f/video.webm%3Bcodecs%3Dvp9%2Copus?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZRKK5ZMRZDHY5HW6%2F20230912%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20230912T035702Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECIaCmFwLXNvdXRoLTEiSDBGAiEAqpvRSq1Os%2FOusICe%2BH28bGFH6RVgtN9%2Bdnz5kFKnlZ8CIQDjGvnlIj9nQp45qwfTnVti17hjsztbdGYwgHLqabBVsCrIBQj7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDY1NTY3NjUyNTM0NyIMkx9PkEDsp%2BjMZQ%2BiKpwFHf9LWdFcS6FtmeMmaHgdKbEZgF%2FZudOjSgKeeHj2PYty6LJbzSux3U%2BuGd5zDgEPSTrq7uZMFYXhgaSjXdpSpIXTIxhULQ0KqI66K6dTwvpF00VLRNDUdaqA0RtAo1TzQyq6fizBabnjiqr%2BwDO3OuyXeayOnRq0xhXVRLrIS1UnaNv6flbWS0yVFDLlf3x8SmA5NpWPd7fbFxzmH7e62CMt0aWs2NXKZ5upm9OqipwEu2wlW8pp1muJeEoXxwqNMnX3GXE3cZYgMMjor%2FU6kIyo7p54B%2FRjWMi%2BoZ%2FeVzFVlQdnWv4LG87R30ucKRaOrHxYvKYc2AOXQn2y5lhwBG20dzNx%2FdRtVVjlR5MmYR1CEzrI0TdMKvcx%2BF5dC4V8%2Fl9DejZGbShZXkzjuPpgprKHYrX2IZeTyIEIRSiIftwUMQsc9or%2FdktIP3UcaLiKexp9HB5qt8A1ASPcMkUc8XRfGFzHIYtt4rddOeGgAq3OebSebahFMEysugT%2BTC4325xmWBbpbyy4rTlGxUGXP%2FdSeD9RtuBtZsUtcYS7ImQ56DhtMYMtyeq4QAby1kkcWPsLBEJueKt6fyfp%2FwTLzkXYGAnMDOV15tOab%2FpbHUSZ6%2FZFX1OrE3eIT%2BLWRDj9rxRQnMfQv%2BwrX6qRtizwHWdZWIK%2B8oU8g%2BOezXYVYeYcN8J%2BiHRrZcZhBMrakPvj4CNbc4x%2B8WzBUe%2BR98%2FEuxF07kmEeRcdmYJxuSUiXcF8PZfId4gVEA0z8vo%2BgfLkFTafIwKtdOprj0j2GtZqU%2BsfLsWPvUs1N0xGWouWa6IrIUO8qC2ybazvDeRNlUcmQ4XVy0pcF4Avqo%2BFGnJmM7C9L6l9PeMhWU7kLygbdXUi0Pa3OpoiBA5%2FgWAwtYz%2FpwY6sAGN6yLdH6T5nyFD4PrPUYqcr%2F4279ttrTDccHdGr2SYC3rVAbJu6jKSBHUiis83Bo1yjY3LNDgwXpfd%2BuYDYyHwhGlriDhb2d9anL2gVer7NGIRBAfyW599HhlmFNEP6okPvSWmTNnSfM%2BAg8RkLLNE1fFiYlQiuDLHB%2FAM%2Fb852RfE2j5sRjn0Jlze2Ho%2FHqguUv4mB05Meb1vQusUZE8N5kRlfJ3gFVrW%2ByJSWG1%2BzA%3D%3D&X-Amz-Signature=7b39277789e8651c7ddf5a650b59416cd05d4790e5926f71ce8d540b01c7164b&X-Amz-SignedHeaders=host"
],
"urls": [],
"length": 0
}
}
},
"attempts": "1",
"previousAttempts": []
}

Success Response Details

FieldDescriptionValues Returned
uploadUrlsThe URL for the recording of the user's video verification.Object (Array)
Was this helpful?
Ask AIBeta
Hi! How can I help?
Ask me anything about HyperVerge products, APIs, and SDKs.
Try asking: